mapbox-maps-android/com.mapbox.maps/[androidJvm]MapSnapshotter

MapSnapshotter

class MapSnapshotter : CameraManager, MapSnapshotterInterface

MapSnapshotter exposes functionality to capture static map images.

Constructors

MapSnapshotter

open fun MapSnapshotter(options: MapSnapshotOptions)

Construct a new snapshotter.

Functions

addPersistentStyleCustomLayer

@NonNull()

open fun addPersistentStyleCustomLayer(layerId: String, layerHost: CustomLayerHost, layerPosition: LayerPosition): Expected<String, None>

Adds a new [style custom layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).

addPersistentStyleLayer

@NonNull()

open fun addPersistentStyleLayer(properties: Value, layerPosition: LayerPosition): Expected<String, None>

Adds a new [style layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).

addStyleCustomGeometrySource

@NonNull()

open fun addStyleCustomGeometrySource(sourceId: String, options: CustomGeometrySourceOptions): Expected<String, None>

Adds a custom geometry to be used in the style.

addStyleCustomLayer

@NonNull()

open fun addStyleCustomLayer(layerId: String, layerHost: CustomLayerHost, layerPosition: LayerPosition): Expected<String, None>

Adds a new [style custom layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).

addStyleImage

@NonNull()

open fun addStyleImage(imageId: String, scale: Float, image: Image, sdf: Boolean, stretchX: List<ImageStretches>, stretchY: List<ImageStretches>, content: ImageContent): Expected<String, None>

Adds an image to be used in the style.

addStyleLayer

@NonNull()

open fun addStyleLayer(properties: Value, layerPosition: LayerPosition): Expected<String, None>

Adds a new [style layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).

addStyleSource

@NonNull()

open fun addStyleSource(sourceId: String, properties: Value): Expected<String, None>

Adds a new [style source](https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources).

cameraForCoordinateBounds

@NonNull()

open fun cameraForCoordinateBounds(bounds: CoordinateBounds, padding: EdgeInsets, bearing: Double, pitch: Double): CameraOptions

Convenience method that returns the `camera options` object for given parameters.

cameraForCoordinates

@NonNull()

open fun cameraForCoordinates(coordinates: List<Point>, camera: CameraOptions, box: ScreenBox): CameraOptions

Convenience method that adjusts the provided `camera options` object for given parameters.

@NonNull()

open fun cameraForCoordinates(coordinates: List<Point>, padding: EdgeInsets, bearing: Double, pitch: Double): CameraOptions

Convenience method that returns the `camera options` object for given parameters.

cameraForGeometry

@NonNull()

open fun cameraForGeometry(geometry: Geometry, padding: EdgeInsets, bearing: Double, pitch: Double): CameraOptions

Convenience method that returns the `camera options` object for given parameters.

cancel

open fun cancel()

Cancel the current snapshot operation.

coordinateBoundsForCamera

@NonNull()

open fun coordinateBoundsForCamera(camera: CameraOptions): CoordinateBounds

Returns the `coordinate bounds` for a given camera.

coordinateBoundsZoomForCamera

@NonNull()

open fun coordinateBoundsZoomForCamera(camera: CameraOptions): CoordinateBoundsZoom

Returns the `coordinate bounds` and the `zoom` for a given `camera`.

coordinateBoundsZoomForCameraUnwrapped

@NonNull()

open fun coordinateBoundsZoomForCameraUnwrapped(camera: CameraOptions): CoordinateBoundsZoom

Returns the unwrapped `coordinate bounds` and `zoom` for a given `camera`.

coordinateForPixel

@NonNull()

open fun coordinateForPixel(pixel: ScreenCoordinate): Point

Calculates a geographical `coordinate` (i.e., longitude-latitude pair) that corresponds to a `screen coordinate`.

coordinatesForPixels

@NonNull()

open fun coordinatesForPixels(pixels: List<ScreenCoordinate>): List<Point>

Calculates geographical `coordinates` (i.e., longitude-latitude pairs) that correspond to `screen coordinates`.

dragEnd

open fun dragEnd()

Ends the ongoing drag gesture.

dragStart

open fun dragStart(point: ScreenCoordinate)

Prepares the drag gesture to use the provided screen coordinate as a pivot `point`.

getBounds

@NonNull()

open fun getBounds(): CameraBounds

Returns the `camera bounds` of the map.

getCameraState

@NonNull()

open fun getCameraState(): CameraState

Returns the current `camera state`.

getDragCameraOptions

@NonNull()

open fun getDragCameraOptions(fromPoint: ScreenCoordinate, toPoint: ScreenCoordinate): CameraOptions

Calculates target point where camera should move after drag.

getElevation

@Nullable()

open fun getElevation(coordinate: Point): Double

Get elevation for the given coordinate.

getFreeCameraOptions

@NonNull()

open fun getFreeCameraOptions(): FreeCameraOptions

Gets the map's current free camera options.

getMapProjection

@NonNull()

open fun getMapProjection(): Value

Returns the currently active map projection and its properties as key-value pairs.

getSize

@NonNull()

open fun getSize(): Size

Gets the size of the snapshot

getStyleDefaultCamera

@NonNull()

open fun getStyleDefaultCamera(): CameraOptions

Returns the map style's default camera, if any, or a default camera otherwise.

getStyleImage

@Nullable()

open fun getStyleImage(imageId: String): Image

Get an `image` from the style.

getStyleJSON

@NonNull()

open fun getStyleJSON(): String

Get the JSON serialization string of the current style in use.

getStyleLayerProperties

@NonNull()

open fun getStyleLayerProperties(layerId: String): Expected<String, Value>

Gets style layer properties.

getStyleLayerProperty

@NonNull()

open fun getStyleLayerProperty(layerId: String, property: String): StylePropertyValue

Gets the value of style layer property.

getStyleLayerPropertyDefaultValue

@NonNull()

open fun getStyleLayerPropertyDefaultValue(layerType: String, property: String): StylePropertyValue

Gets the default value of style layer property

getStyleLayers

@NonNull()

open fun getStyleLayers(): List<StyleObjectInfo>

Returns the existing style layers.

getStyleLightProperty

@NonNull()

open fun getStyleLightProperty(property: String): StylePropertyValue

Gets the value of a style light property.

getStyleSourceProperties

@NonNull()

open fun getStyleSourceProperties(sourceId: String): Expected<String, Value>

Gets style source properties.

getStyleSourceProperty

@NonNull()

open fun getStyleSourceProperty(sourceId: String, property: String): StylePropertyValue

Gets the value of style source property.

getStyleSourcePropertyDefaultValue

@NonNull()

open fun getStyleSourcePropertyDefaultValue(sourceType: String, property: String): StylePropertyValue

Gets the default value of style source property.

getStyleSources

@NonNull()

open fun getStyleSources(): List<StyleObjectInfo>

Returns the existing style sources.

getStyleTerrainProperty

@NonNull()

open fun getStyleTerrainProperty(property: String): StylePropertyValue

Gets the value of a style terrain property.

getStyleTransition

@NonNull()

open fun getStyleTransition(): TransitionOptions

Returns the map style's transition options.

getStyleURI

@NonNull()

open fun getStyleURI(): String

Get the URI of the current style in use.

invalidateStyleCustomGeometrySourceRegion

@NonNull()

open fun invalidateStyleCustomGeometrySourceRegion(sourceId: String, bounds: CoordinateBounds): Expected<String, None>

Invalidate region for provided custom geometry source.

invalidateStyleCustomGeometrySourceTile

@NonNull()

open fun invalidateStyleCustomGeometrySourceTile(sourceId: String, tileId: CanonicalTileID): Expected<String, None>

Invalidate tile for provided custom geometry source.

isInTileMode

open fun isInTileMode(): Boolean

Returns `true` if the snapshotter is in the tile mode.

isStyleLayerPersistent

@NonNull()

open fun isStyleLayerPersistent(layerId: String): Expected<String, Boolean>

Checks if a style layer is persistent.

isStyleLoaded

open fun isStyleLoaded(): Boolean

Check if the style is completely loaded.

moveStyleLayer

@NonNull()

open fun moveStyleLayer(layerId: String, layerPosition: LayerPosition): Expected<String, None>

Moves an existing style layer

pixelForCoordinate

@NonNull()

open fun pixelForCoordinate(coordinate: Point): ScreenCoordinate

Calculates a `screen coordinate` that corresponds to a geographical coordinate (i.e., longitude-latitude pair).

pixelsForCoordinates

@NonNull()

open fun pixelsForCoordinates(coordinates: List<Point>): List<ScreenCoordinate>

Calculates `screen coordinates` that correspond to geographical `coordinates` (i.e., longitude-latitude pairs).

removeStyleImage

@NonNull()

open fun removeStyleImage(imageId: String): Expected<String, None>

Removes an image from the style.

removeStyleLayer

@NonNull()

open fun removeStyleLayer(layerId: String): Expected<String, None>

Removes an existing style layer.

removeStyleSource

@NonNull()

open fun removeStyleSource(sourceId: String): Expected<String, None>

Removes an existing style source.

setBounds

@NonNull()

open fun setBounds(options: CameraBoundsOptions): Expected<String, None>

Sets the `camera bounds options` of the map.

setCamera

open fun setCamera(cameraOptions: CameraOptions)

Changes the map view by any combination of center, zoom, bearing, and pitch, without an animated transition.

open fun setCamera(freeCameraOptions: FreeCameraOptions)

Sets the map view with the free camera options.

setMapProjection

@NonNull()

open fun setMapProjection(projection: Value): Expected<String, None>

Updates the active map projection.

setSize

open fun setSize(size: Size)

Sets the `size` of the snapshot

setStyleCustomGeometrySourceTileData

@NonNull()

open fun setStyleCustomGeometrySourceTileData(sourceId: String, tileId: CanonicalTileID, featureCollection: List<Feature>): Expected<String, None>

Set tile data of a custom geometry.

setStyleJSON

open fun setStyleJSON(json: String)

Load the style from a provided JSON string.

setStyleLayerProperties

@NonNull()

open fun setStyleLayerProperties(layerId: String, properties: Value): Expected<String, None>

Sets style layer properties.

setStyleLayerProperty

@NonNull()

open fun setStyleLayerProperty(layerId: String, property: String, value: Value): Expected<String, None>

Sets a value to a style layer property.

setStyleLight

@NonNull()

open fun setStyleLight(properties: Value): Expected<String, None>

Sets the style global [light](https://docs.mapbox.com/mapbox-gl-js/style-spec/#light) properties.

setStyleLightProperty

@NonNull()

open fun setStyleLightProperty(property: String, value: Value): Expected<String, None>

Sets a value to the the style light property.

setStyleSourceProperties

@NonNull()

open fun setStyleSourceProperties(sourceId: String, properties: Value): Expected<String, None>

Sets style source properties.

setStyleSourceProperty

@NonNull()

open fun setStyleSourceProperty(sourceId: String, property: String, value: Value): Expected<String, None>

Sets a value to a style source property.

setStyleTerrain

@NonNull()

open fun setStyleTerrain(properties: Value): Expected<String, None>

Sets the style global [terrain](https://docs.mapbox.com/mapbox-gl-js/style-spec/#terrain) properties.

setStyleTerrainProperty

@NonNull()

open fun setStyleTerrainProperty(property: String, value: Value): Expected<String, None>

Sets a value to the the style terrain property.

setStyleTransition

open fun setStyleTransition(transitionOptions: TransitionOptions)

Overrides the map style's transition options with user-provided options.

setStyleURI

open fun setStyleURI(uri: String)

Load style from provided URI.

setTileMode

open fun setTileMode(set: Boolean)

Sets the snapshotter to the tile mode.

start

open fun start(callback: SnapshotCompleteCallback)

Start the rendering of a snapshot.

styleLayerExists

open fun styleLayerExists(layerId: String): Boolean

Checks whether a given style layer exists.

styleSourceExists

open fun styleSourceExists(sourceId: String): Boolean

Checks whether a given style source exists.

open fun subscribe(observer: Observer, events: List<String>)

Subscribes an `observer` to a provided array of event types.

unsubscribe

open fun unsubscribe(observer: Observer)

Unsubscribes an `observer` from all events.

open fun unsubscribe(observer: Observer, events: List<String>)

Unsubscribes an `observer` from a provided array of event types.

updateStyleImageSourceImage

@NonNull()

open fun updateStyleImageSourceImage(sourceId: String, image: Image): Expected<String, None>

Updates the image of an [image style source](https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources-image).